Skip to content

Generate Changelog from commits #126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 25 commits into from
Jan 25, 2020
Merged

Generate Changelog from commits #126

merged 25 commits into from
Jan 25, 2020

Conversation

Lee-W
Copy link
Member

@Lee-W Lee-W commented Jan 24, 2020 •
edited
Loading

#53
Generate changelog from commits but it will overwrite the existing file. It now supports --dry-run, --start-rev and --file-name arguments. I also merge the WIP commit you implemented here, but it's not used. They may be useful when we're merging the new changelog with the existing one.

TODO

  • Find out a way to merge changelog with existing file
  • Get the latest version from config and use it as the default of changelog command

Example

The following changelog is an example generated comparing to the master branch.

# CHANGELOG

## Unreleased
### feat
- make changelog_file an option in config
- exit when there is no commit exists
- add --start-rev argument to `cz changelog`
- generate changelog based on git log
- generate changelog_tree from all past commits
- add changelog_map, changelog_pattern and implement process_commit
- add default process_commit for processing commit message
- changelog tree generation from markdown

### fix
- fix list format
- set changelog_map, changelog_pattern to none as default
- remove --skip-merge argument
- add changelog arguments

woile and others added 25 commits January 21, 2020 22:12
@woile @Lee-W
feat(changelog): changelog tree generation from markdown
f22a91f
@Lee-W
feat(cz/base): add default process_commit for processing commit message
bf047e9
@Lee-W
feat(cz/conventinal_commits): add changelog_map, changelog_pattern an…
632a3e4 
…d implement process_commit
@Lee-W
feat(commands/changelog): generate changelog_tree from all past commits
08e8238 
TODO: find rev for each changelog entry
@Lee-W
feat(changelog): generate changelog based on git log
84ca569 
it will over write the existing file
@Lee-W
style(all): blackify
c158042
@Lee-W
refactor(commands/changelog): use jinja2 template instead of string c…
075b055 
…oncatenation to build changelog

* install jinja2
* use named caputure group for changelog_pattern
@Lee-W
fix(cli): add changelog arguments
6215c29
@Lee-W
feat(commands/changlog): add --start-rev argument to cz changelog
e52eda7
@Lee-W
style(cli): fix flake8 issue
ceaf71b
@Lee-W
refactor(commands/changelog): remove redundant if statement
ae3c521
@Lee-W
refactor(tests/utils): move create_file_and_commit to tests/utils
529f5a2
@Lee-W
feat(commands/changelog): exit when there is no commit exists
c12e44e
@Lee-W
fix(commands/changelog): remove --skip-merge argument
e871d16 
by default, unrelated commits are ignored
@Lee-W
fix(commitizen/cz): set changelog_map, changelog_pattern to none as d…
273e736 
…efault

without this default, getting these attributes will be an error
@Lee-W
fix(changelog_template): fix list format
8fb8c71
@Lee-W
test(commands/changelog): add test case for changelog command
aa877dc
@Lee-W
refactor(templates): move changelog_template from cz to templates
02d8a17
@Lee-W
refactor(cli): reorder commands
32304b4
@Lee-W
docs(README): add changelog command
8916548
@Lee-W
refactor(templates): remove unneeded __init__ file
9b6fd57
@Lee-W
style(tests/commands/changelog): blackify
4f0272f
@Lee-W
refactor(templates): rename as "keep_a_changelog_template.j2"
3278414
@Lee-W
feat(commands/changelog): make changelog_file an option in config
780dbe1
@Lee-W
docs(config): add changlog_file a config option
5c152a4
@Lee-W Lee-W requested a review from woile January 24, 2020 08:45
@woile
Copy link
Member

woile commented Jan 24, 2020

You are the best @Lee-W !! Would you mind sending this PR to the branch command-changelog, I'd also like to contribute to this changes, and once we have it a bit more polish we release it

@Lee-W Lee-W changed the base branch from master to command-changelog January 25, 2020 01:41
@Lee-W
Copy link
Member Author

Lee-W commented Jan 25, 2020

Sure! This workflow makes more sense to me. The changelog seems to be a huge update to me. We should make sure it works well enough before release. 😀

@woile woile merged commit 718b881 into commitizen-tools:command-changelog Jan 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@woile woile Awaiting requested review from woile

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Lee-W @woile